Skip to content

Correct and fill in gaps in the logs, MQTT topics and web interface pages - #174

Open
jamesmulcahy wants to merge 1 commit into
NSPManager:mainfrom
jamesmulcahy:docs/corrections-2.1.10
Open

jamesmulcahy wants to merge 1 commit into
NSPManager:mainfrom
jamesmulcahy:docs/corrections-2.1.10

Conversation

@jamesmulcahy

Copy link
Copy Markdown
Contributor

Summary

Brings several existing pages up to date with what the manager and firmware do today. It's one of the first steps in documenting everything since 2.1.5. It only corrects and fills in pages that already exist; new feature pages (covers, buzzer sounds, media players and so on) will follow separately.

Logs (advanced/logs.md)

  • The log topic is nspanel/<mac>/log, not nspanel/<panel name>/log.
  • Documents the panel's new Serial log setting (Auto / Always / Never, from NSPanelManager-firmware#60). With the default, Auto, a panel only writes to serial while it isn't connected to MQTT.
  • Explains the LoopWatchdog lines a panel logs when its event loop stalls (NSPanelManager-firmware#69), and that they're useful in a bug report.

MQTT topics (advanced/mqtt-topics.md)

  • Removes the duplicated all_rooms_state row.
  • Adds buzzer_mute_cmd / buzzer_mute_state (NSPanelManager#400) and status/epoch (NSPanelManager#404).
  • Describes buzzer_raw_command as an RTTTL tune, where an empty message stops playback.

Web interface (web-interface.md)

  • Button modes: adds Thermostat (heating) and Thermostat (cooling) modes (NSPanelManager#112): how the relay follows the lower and upper temperatures, that the panel uses only its internal sensor, and the cautions shown on the settings page.
  • Thermostat step size: applies to Home Assistant thermostats too, not just OpenHAB. Defaults to 0.5.
  • Delete a room: what's deleted with the room, and when the last room can't be deleted (NSPanelManager#411).
  • Turn on behavior: describes the two options, Color temperature and Restore, including the behaviour from NSPanelManager#416.
  • Room status backoff time: the per-room setting next to the existing "All rooms" one.

Each change was checked against the code on devel.

The "Open the room's first media player" button mode is left for the media player docs. It opens the media player page, which arrives in the TFTs with NSPanelManager#408.

Screenshots (TODO)

These pages still show the older UI and need new screenshots at some point:

  • the NSPanel page (button mode options)
  • the settings page, now in React (NSPanelManager#424)
  • the room page

🤖 Generated with Claude Code

…ages

- Logs: the log topic is nspanel/<mac>/log. Document the panel's Serial log
  setting and the LoopWatchdog lines.
- MQTT topics: remove the duplicate all_rooms_state row; add buzzer_mute_cmd,
  buzzer_mute_state and status/epoch; describe buzzer_raw_command as RTTTL.
- Web interface: add the Thermostat (heating/cooling) button modes, the
  Room status backoff time setting, the two Turn on behavior options and
  deleting a room. Thermostat step size applies to Home Assistant too.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@tpanajott tpanajott left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice update. I'll hold off on publishing these until the new beta is out.

Comment thread docs/web-interface.md

Press **Delete** on the room page and confirm. The room's entities, scenes and pages are deleted with it, and any panels
in the room are moved to another room.
The last room can't be deleted while panels are assigned to it. Create another room or remove the panels first.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is no longer correct. This behavior has been rectified since I stumbled upon that test as it was incorrect behavior. Having no rooms defined at all means that no new panel can register.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you clarify what the behavior is now then, as the behavior it describes seems to match what I'd expect? What happens now if you delete the last room -- doesn't that lead to to the situation you're trying to avoid and reference in the final sentence?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its no longer possible to delete the last room regardless of if it has any panels or not.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants